home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Texteditors / SkoEd / skoed.doc < prev    next >
Encoding:
Text File  |  1996-09-27  |  41.8 KB  |  1,694 lines
  1.  
  2. MAIN
  3.  
  4.                             SkoEd V1.14
  5.                    A Programmer's Editor Revisited.
  6.                    Copyright (c) 1993 David McPaul
  7.  
  8.  
  9.  
  10.         Introduction
  11.         Features
  12.         Installation
  13.         Starting SkoEd
  14.         Configuring SkoEd
  15.         Commands
  16.         AREXX
  17.         Examples
  18.         Distribution
  19.         Registering
  20.  
  21.         DISCLAIMER
  22.         INDEX
  23.  
  24.     AmigaGuide Documentation produced using AmigaGuide Writer by me :-)
  25.  
  26.     SkoEd Icons and Gadgets created using IE by Peter Kiem.
  27.  
  28.  
  29. INTRODUCTION
  30.  
  31.   Before getting into this wonderfull doco :-) a quick look at why I wrote
  32. SkoEd.
  33.  
  34.   Why another editor?  Hmm it is hard to say, but the more I look around at
  35. editors the more I think that an Editor is a very personal preference.  Not
  36. just in the keymappings (After all most editors these days will remap keys) but
  37. also in how they look and how they operate.  (I refuse to say look and feel
  38. only a lawyer would use such terms).
  39.  
  40.   Well, when I got my Amiga I found that there were no editors around that I
  41. really liked.  Some were good and did quite a lot but they were not me.  So I
  42. wrote SkoEd which is in may ways my personal preference.  SkoEd is by no means
  43. the begin and end all of Editors; there are a number of areas which need
  44. improving.  It is however at a stage that I feel can be released to the Amiga
  45. community.
  46.  
  47. FEATURES
  48.  
  49.  
  50.   Here is a list of what SkoEd can do.
  51.  
  52.     - Remaps keystrokes to commands.
  53.     - Customisable.
  54.     - Multiple Files.
  55.     - Multiple Views of files.
  56.     - Clones the WorkBench Screen and WorkBench Screen text font.
  57.     - Set own Screen and Font.
  58.     - Reads,Writes and Converts IBM format files.
  59.     - A FAST Find/Replace.
  60.     - Column Blocks.
  61.     - Clipboard support.
  62.     - AutoSave after time limit expires.
  63.     - Folding.
  64.     - Match {([])}.
  65.     - Count number of braces {} in a file.
  66.     - Word Completion. (I like this one :-)
  67.     - Zoom/Explode of Views.
  68.     - Memory file to remember files previously loaded and cursor location.
  69.     - Unlimited Marks to allow you to go instantly to a marked location.
  70.     - Undelete n Deletes. (n is setable)
  71.     - Iconify.
  72.     - Script file bit is handled correctly (and is settable).
  73.     - AREXX
  74.     - User Configurable Gadget Strip
  75.     - And other, less obvious functions.
  76.  
  77.   Here are the areas I wish to improve.
  78.     - A full macro language. (although with Arexx do I need this?)
  79.     - A full Undo as opposed to Undelete (and Redo).
  80.     - Repeat command.
  81.     - Allow user to create own menu strips.
  82.  
  83.  
  84. INSTALLATION
  85.  
  86.         SkoEd is for Workbench 2.0 and 3.0 only.
  87.  
  88.                 To Install SkoEd you may either:
  89.  
  90.         Use the Installer Script supplied or,
  91.  
  92.         Copy Skoed to somewhere in your path.
  93.         Copy Skoed.Config to the directory where SkoEd is located.
  94.         Copy Skoed.Macro to the directory you work in.
  95.         Copy Gadgets directory to the directory where SkoEd is located.
  96.         Make a directory in ENV: called SkoEd.
  97.  
  98.         Edit both Skoed.Config and Skoed.Macro to map the key to commands etc.
  99.         Add the Assign SkoEd: <place where SkoEd is located> to user startup.
  100.  
  101.         A note about the support files (Config & Macro) The following search
  102. order is performed - Current Directory, The Directory SkoEd was loaded from
  103. then "SKOED:".  The way I work things is Config goes where SkoEd is located
  104. and Macro goes in my work directory.  This way unchanging keymaps and
  105. commands are in SkoEd.Config and work specific commands are in SkoEd.Macro.
  106.  
  107.         Additional support files are for the gadget strip.  SkoEd looks for
  108. the gadgets using "<Search Path>Gadgets/#?.info".  Any Icon located in that
  109. directory is checked for a COMMAND string and loaded into the gadget strip.
  110. The <Search Path> is the same as for the Config and Macro files.
  111.  
  112.         These system libraries are needed in libs:
  113.  
  114.         ReqTools.library
  115.         IffParse.library
  116.  
  117. DISTRIBUTION
  118.  
  119.  
  120.                         SKOED VERSION 1.14 is SHAREWARE
  121.  
  122.         So you may,
  123.  
  124.  
  125.         Distribute the NON REGISTERED versions of SkoEd as much as you like.
  126. However no more than a nominal fee may be charged for distributing SkoEd.
  127.  
  128.         If you use SkoEd on a regular basis then you should REGISTER.
  129.         Registered users receive :
  130.  
  131.                 - The latest version,
  132.                 - 1 free update and then,
  133.                 - Notification of the next update.
  134.  
  135.         Registration is only $25.00 Australian (which is cheaper than you
  136. think considering most exchange rates :-)
  137.  
  138. Please send Registration fee to:
  139.  
  140.     David McPaul,
  141.     P.O. Box 2830,
  142.     Canberra,
  143.     A.C.T,
  144.     AUSTRALIA,
  145.     2601.
  146.  
  147.         I prefer International Money Orders, Bankers Cheques or Cash.
  148. Personal cheques are just too difficult to get changed.
  149.  
  150.         Please include with your Registration:
  151.  
  152.                 Your Name (So I can personalise SkoEd for you)
  153.                 Your Address (So you can get SkoEd sent to you :-)
  154.                 Comments, thoughts, wish list etc or even just a hello.
  155.  
  156.         Other programs available
  157.  
  158.                 - AmigaGuide Writer (AGW) ($15)
  159.  
  160.  
  161. Folding
  162.  
  163.         Folding is a method whereby sections of code is hidden from
  164. the display.  This makes the studying of code sections easier because you
  165. hide away code that you know is working or not relevant.  SkoEd allows you
  166. to highlight the section of code that you do not wish to see and use the
  167. Fold_Block command to hide it away.  Unfold reverses this process.
  168.  
  169.  
  170. Gadgets
  171.  
  172.         SkoEd now supports a user configurable gadget strip.  To add a
  173. gadget to the strip just create an icon with a maximum height of 28 pixels
  174. and store it in "Gadgets/".  Add a COMMAND tooltype and you are ready
  175. to go.
  176.  
  177.         TOOLTYPES Used are:
  178.  
  179.         COMMAND  - This is the command that will be executed by skoed when
  180.                    you press the gadget.  Macros are also supported.
  181.                    e.g COMMAND=Make;
  182.                    or  COMMAND=ARexx(screxx:NextError.Rexx);
  183.  
  184.         TICK     - Add this tooltype if you want the command to be repeated
  185.                    while the gadget is activated.  This tooltype overrides
  186.                    the GADGETUP tooltype.
  187.  
  188.         GADGETUP - Add this tooltype if you want the command to be executed
  189.                    when the gadget is released instead of selected.  Does
  190.                    not function when TICK is present.
  191.  
  192.         ORDER    - This tooltype controls the order of gadget placement.
  193.                    by giving each icon an ORDER of placement you can control
  194.                    which gadget goes where.
  195.                    e.g ORDER=5
  196.                         This makes the gadget the 5th gadget in the strip.
  197.                    Note if you do not supply an order it defaults to 0 and
  198.                    this may affect other gadget ordering.
  199.  
  200.         GAP      - Use to determine the GAP between this gadget and the
  201.                    previous gadget.
  202.                    e.g GAP=30
  203.                         This leaves 30 pixels between this gadget and the
  204.                         previous gadget default is 3.
  205.  
  206.  
  207.  
  208. EXECUTION
  209.  
  210.         SkoEd only works with Workbench 2.0 and above.
  211.  
  212.         SkoEd can be started via the CLI or the Workbench, when run from the
  213. CLI some parameters may be accepted.  These may be seen by typing Skoed ?
  214.  
  215. Usage: Skoed [options] [filename]
  216. options are :
  217. +r - Use Reload file if available
  218. -r - Don't use a Reload file if found
  219.  
  220.         The filename specified in the command line will be loaded (names
  221. can be surrounded by double quotes ("") if the name contains spaces).
  222.  
  223.         SkoEd will open it's own Public screen (SkoEd).  The screens width,
  224. Height and Font will be cloned from the Workbench Screen & Screen font.  If
  225. the font found is a non proportional font then topaz/8 will be used.
  226.  
  227.         SkoEd can then be configured using the Set Font and Set Screen menu
  228. options.  When you have decided on your preferred Screen and Font select 
  229. Save Prefs.
  230.  
  231. CONFIGURATION
  232.  
  233.         In order to use SkoEd with the keymappings you like, then you will
  234. need to change the SkoEd.Config/SkoEd.Macro files to contain the mappings
  235. you wish to use.
  236.  
  237.   Each keymapping is of the format :
  238.  
  239.   <Key Description> <Equals> <String>|<Command> <SemiColon> <Comment>
  240.  
  241.   where
  242.  
  243.   <Equals>          -> =
  244.   <SemiColon>       -> ;
  245.   <Comment>         -> Whatever you like.
  246.   <Key Description> -> {<Qualifier>}<Key>{<Key>}
  247.   <Command>         -> <CommandName>{<(><Parameters><)>}
  248.   <CommandName>     -> A command from the command list.
  249.   <Parameters>      -> The parameters seperated by spaces that are to be
  250.                        parsed by the command using ReadArgs.
  251.   <(>               -> (
  252.   <)>               -> )
  253.   <String>          -> Anything enclosed in Double Quotes e.g "fred"
  254.   <Qualifier>       -> A qualifier from the list below.
  255.   <Key>             -> The key you wish to map (Case is ignored)
  256.  
  257. Qualifiers are :
  258.  
  259. #  - Shift key
  260. ^  - Control key
  261. @  - Alt key
  262. &  - Numeric Keypad
  263. !L - Left Amiga
  264. !R - Right Amiga
  265.  
  266. or you may also use
  267.  
  268. SHIFT      - Shift key
  269. CTRL       - Control key
  270. ALT        - Alt key
  271. KEYPAD     - Numeric Keypad
  272. LEFTAMIGA  - Left Amiga
  273. RIGHTAMIGA - Right Amiga
  274.  
  275. Special Keys are :
  276.  
  277. $Fn where 0 <= n <= 9 - Function keys
  278. RETURN                - The Return Key
  279. UP                    - The up arrow key
  280. DOWN                  - The down arrow key
  281. LEFT                  - The left arrow key
  282. RIGHT                 - The right arrow key
  283. DEL                   - The Del key
  284. HELP                  - The Help key
  285. BACKSPACE             - The Backspace key
  286. TAB                   - The Tab key
  287. ESC                   - The ESC key
  288. \                     - The next character is not a special character
  289.                         eg \# is the hash character not a Shift qualifier.
  290.  
  291. See also Examples and ARexx
  292.  
  293.         Several variables may also be set in the configuration files.  These
  294. are :
  295.  
  296.    C_DIR       - This string determines where to save the current file for 
  297.                  compiling.  Set to blank if you wish to us current 
  298.                  directory.
  299.    COMPILE     - This string is inserted before the filename and then that 
  300.                  string is passed to System().  eg "SC" to use the SAS C 
  301.                  compiler.
  302.    LINK        - This string is passed to System when you call the Link 
  303.                  command.
  304.    MAKE        - This string is passed to System when you call the Make 
  305.                  command.
  306.    EXECUTE     - This is the default string to use when you call the Run 
  307.                  command.
  308.    ERRORS      - This is the default string to use when you call the Errors 
  309.                  command.
  310.    CLI         - This is the default string to create a new CLI/Shell.
  311.    INSERT      - This boolean variable is set to TRUE if you want insert 
  312.                  mode to be on at startup.
  313.    INDENT      - This boolean variable is set to TRUE if you want automatic 
  314.                  indenting to be on.
  315.    CAPTIVECRSR - This boolean variable is set to TRUE if you want Captive 
  316.                  Cursor mode on at startup.
  317.    MEMORY      - This boolean variable is set to TRUE if you want to have 
  318.                  SkoEd save memory files when you exit.
  319.    BACKUPS     - This boolean variable is set to TRUE if you want to have 
  320.                  SkoEd create .BAK files when saving.
  321.    TABSIZE     - This numeric variable sets the size of a TAB character.
  322.    AUTOTIME    - This numeric variable sets the amount of time in minutes 
  323.                  between autosaves of the most changed file.
  324.    MAXUNDO     - This numeric variable sets the maximum level of Undo you 
  325.                  want.
  326.    RELOAD      - This boolean variable if set to TRUE in the config file 
  327.                  will force a reload if a memory file is available.
  328.    PRINTER     - This string is passed to System() and is used to support 
  329.                  printing.
  330.    SAVETABS    - This boolean variable is set to TRUE if you want SkoEd to 
  331.                  save every TABSIZE spaces at the start of a line as a TAB 
  332.                  character.
  333.    LOADTABS    - This boolean variable is set to TRUE if you want SkoEd to 
  334.                  load TABS as TABS and NOT convert them to spaces.
  335.    TABSSPACES  - This boolean variable is set to TRUE if you want TAB command 
  336.                  to output TABSIZE spaces or a TAB character.
  337.  
  338.  
  339. AREXX
  340.  
  341.  
  342.         SkoEd now has an Arexx Port named "SKOED1".  All commands are
  343. available to Arexx via this port.  All commands in SkoEd are Case Sensistive
  344. and should therefor be enclosed in Quotes.
  345.  
  346. For example to put up the About requester in Skoed
  347.  
  348. ADDRESS SKOED1 "About"
  349.  
  350.         Commands will either return 0 for success or 10 for failure.
  351.  
  352.         Some commands accept parameters (eg Load_File) and parameters are
  353. passed as follows:
  354.  
  355. ADDRESS SKOED1 "Load_File(work:Skoed.doc)"
  356. ADDRESS SKOED1 "Goto_Line(10)"
  357.  
  358.         Basically everything between the () is passed to the routine as a single
  359. string and then ParseArgs is used to make sense of it.
  360.  
  361.         The same method of parameter passing is used for parameter passing in
  362. SkoEd.Config.
  363.  
  364.         See the example ARexx routines given for more clues on interfacing
  365. ARexx to SkoEd.
  366.  
  367. COMMANDS
  368.  
  369.  Movement Commands               File/Buffer Commands
  370.  
  371.  Up                              Load_File
  372.  Down                            Save_File
  373.  Left                            Print_File
  374.  Right                           Reload
  375.  Page_Up                         Kill_Buffer
  376.  Page_Down                       Make_Buffer
  377.  StartOfFile                     Print_Buffer
  378.  EndOfFile                       Next_Buffer
  379.  StartOfLine                     Prev_Buffer
  380.  EndOfLine                       Goto_Buffer
  381.  Scroll_Up                       Buffer_Info
  382.  Scroll_Down
  383.  Scroll_Left                     Block Commands
  384.  Scroll_Right
  385.  Goto_Line                       Block_Begin
  386.  Goto_Column                     Block_End
  387.  UpUp                            Block_Copy
  388.  DownDown                        Block_Delete
  389.                                   Block_Move
  390.  Word Commands                    StartOfBlock
  391.                                   EndOfBlock
  392.  Word_Left                       Block_Hide
  393.  Word_Right                      Block_Clip
  394.  Word_End                        Clip_Block
  395.  Word_Delete                     Block_File
  396.  Complete_Word                   File_Block
  397.                                   Block_Mode
  398.  Fold Commands                    Indent_Block
  399.                                   Unindent_Block
  400.  Fold_Line                       Undo
  401.  Unfold_Line
  402.  Fold_Block                      String Commands
  403.  Unfold
  404.  Next_Fold                       Find
  405.  Prev_Fold                       Replace
  406.                                   Again
  407.  Mark Commands                    Match
  408.                                   Count_Braces
  409.  Mark                            Str_Size
  410.  Unmark
  411.  Next_Mark
  412.  Prev_Mark                       CLI/Compiler Commands
  413.  Goto_Mark
  414.                                   Compile
  415.  Window Commands                  Link
  416.                                   Run
  417.  Split_Window                    Make
  418.  Close_Window                    Errors
  419.  Zoom                            New_CLI
  420.  Explode
  421.  Refresh
  422.                                  Generic Editing Commands
  423.  Miscellaneous Commands
  424.                                   Return
  425.  None                            Backspace
  426.  Set_Var                         Tab
  427.  Get_Var                         Del
  428.  Set_Env                         Del_Line
  429.  Set_Vars                        Del_EOL
  430.  Auto_Save                       Del_SOL
  431.  Iconify                         Exit
  432.  Reconfigure
  433.  Msg
  434.  ARexx
  435.  
  436. UpUp
  437.  
  438. COMMAND     : UpUp
  439.  
  440.  PARAMETERS : NONE
  441.  
  442.  DESCRIPTION: This command moves the Cursor up 1 line, scrolling if needed.
  443.               This routine attempts to keep the Cursor 1 line below the
  444.               topline so that the line above the Cursor is always visible.
  445.  
  446. DownDown
  447.  
  448. COMMAND     : DownDown
  449.  
  450.  PARAMETERS : NONE
  451.  
  452.  DESCRIPTION: This command moves the Cursor Down 1 line, scrolling if needed.
  453.               This routine attempts to keep the Cursor 1 line above the
  454.               bottomline so that the line below the Cursor is always
  455.               visible.
  456.  
  457. StartOfBlock
  458.  
  459. COMMAND     : StartOfBlock
  460.  
  461.  PARAMETERS : NONE
  462.  
  463.  DESCRIPTION: This command moves the Cursor to the start of the current 
  464.               Block.
  465.  
  466. EndOfBlock
  467.  
  468. COMMAND     : EndOfBlock
  469.  
  470.  PARAMETERS : NONE
  471.  
  472.  DESCRIPTION: This command moves the Cursor to the end of the current Block.
  473.  
  474.  
  475. Up
  476.  
  477. COMMAND     : Up
  478.  
  479.  PARAMETERS : NONE
  480.  
  481.  DESCRIPTION: This moves the Cursor up 1 line, scrolling if needed.
  482.  
  483.  See Also   : Down Left Right Page_Up Page_Down
  484.  
  485. Down
  486.  
  487. COMMAND     : Down
  488.  
  489.  PARAMETERS : NONE
  490.  
  491.  DESCRIPTION: This moves the Cursor Down 1 line, scrolling if needed.
  492.  
  493.  See Also   : Up Left Right Page_Up Page_Down
  494.  
  495. Left
  496.  
  497. COMMAND     : Left
  498.  
  499.  PARAMETERS : NONE
  500.  
  501.  DESCRIPTION: This moves the Cursor Left 1 character.  If the Start of a
  502.               line is reached the the Cursor is move to the end of the line
  503.               above.
  504.  
  505.  See Also   : Up Down Right Page_Up Page_Down
  506.  
  507. Right
  508.  
  509. COMMAND     : Right
  510.  
  511.  PARAMETERS : NONE
  512.  
  513.  DESCRIPTION: This moves the Cursor Right 1 character until you reach the
  514.               maximum length of the line (Currently 4096 chars).
  515.  
  516.  See Also   : Up Down Left Page_Up Page_Down
  517.  
  518. Page_Up
  519.  
  520. COMMAND     : Page_Up
  521.  
  522.  PARAMETERS : NONE
  523.  
  524.  DESCRIPTION: Move Cursor up 1 page.
  525.  
  526.  See Also   : Up Down Left Right Page_Down
  527.  
  528. Page_Down
  529.  
  530. COMMAND     : Page_Down
  531.  
  532.  PARAMETERS : NONE
  533.  
  534.  DESCRIPTION: Move Cursor down 1 page.
  535.  
  536.  See Also   : Up Down Left Right Page_Up
  537.  
  538. StartOfFile
  539.  
  540. COMMAND     : StartOfFile
  541.  
  542.  PARAMETERS : NONE
  543.  
  544.  DESCRIPTION: Move to First Line, First Column of File.
  545.  
  546.  See Also   : EndOfFile
  547.  
  548. EndOfFile
  549.  
  550. COMMAND     : EndOfFile
  551.  
  552.  PARAMETERS : NONE
  553.  
  554.  DESCRIPTION: Move to Last Line, End of the Line.
  555.  
  556.  See Also   : StartOfFile
  557.  
  558. StartOfLine
  559.  
  560. COMMAND     : StartOfLine
  561.  
  562.  PARAMETERS : NONE
  563.  
  564.  DESCRIPTION: Move to the Start of Current Line.
  565.  
  566.  See Also   : EndOfLine
  567.  
  568. EndOfLine
  569.  
  570. COMMAND     : EndOfLine
  571.  
  572.  PARAMETERS : NONE
  573.  
  574.  DESCRIPTION: Move to End of Current Line.
  575.  
  576.  See Also   : StartOfLine
  577.  
  578. Scroll_Up
  579.  
  580. COMMAND     : Scroll_Up
  581.  
  582.  PARAMETERS : NONE
  583.  
  584.  DESCRIPTION: Scroll File Up beneath the Cursor.
  585.  
  586.  See Also   : Scroll_Down Scroll_Left Scroll_Right
  587.  
  588. Scroll_Down
  589.  
  590. COMMAND     : Scroll_Down
  591.  
  592.  PARAMETERS : NONE
  593.  
  594.  DESCRIPTION: Scroll File Down beneath the Cursor.
  595.  
  596.  See Also   : Scroll_Up Scroll_Left Scroll_Right
  597.  
  598. Scroll_Left
  599.  
  600. COMMAND     : Scroll_Left
  601.  
  602.  PARAMETERS : NONE
  603.  
  604.  DESCRIPTION: Scroll File Left beneath the Cursor.
  605.  
  606.  See Also   : Scroll_Up Scroll_Down Scroll_Right
  607.  
  608. Scroll_Right
  609.  
  610. COMMAND     : Scroll_Right
  611.  
  612.  PARAMETERS : NONE
  613.  
  614.  DESCRIPTION: Scroll File Right beneath the Cursor.
  615.  
  616.  See Also   : Scroll_Up Scroll_Down Scroll_Left
  617.  
  618. Word_Left
  619.  
  620. COMMAND     : Word_Left
  621.  
  622.  PARAMETERS : NONE
  623.  
  624.  DESCRIPTION: Move the Cursor to the previous word if at the start of a word
  625.               or move to the start of the current word.
  626.  
  627.  See Also   : Word_Right Word_End Word_Delete Complete_Word
  628.  
  629. Word_Right
  630.  
  631. COMMAND     : Word_Right
  632.  
  633.  PARAMETERS : NONE
  634.  
  635.  DESCRIPTION: Move the Cursor to the start of the next word.
  636.  
  637.  See Also   : Word_Left Word_End Word_Delete Complete_Word
  638.  
  639. Word_End
  640.  
  641. COMMAND     : Word_End
  642.  
  643.  PARAMETERS : NONE
  644.  
  645.  DESCRIPTION: Move the Cursor to the end of the current word.
  646.  
  647.  See Also   : Word_Left Word_Right Word_Delete Complete_Word
  648.  
  649. Goto_Line
  650.  
  651. COMMAND     : Goto_Line
  652.  
  653.  PARAMETERS : LINE/N
  654.  
  655.  DESCRIPTION: Goto a line Number.  If Line number is not given then display a
  656.               Requester asking for a line number.
  657.  
  658.  See Also   : Goto_Column Goto_Buffer
  659.  
  660. Goto_Column
  661.  
  662. COMMAND     : Goto_Column
  663.  
  664.  PARAMETERS : COLUMN/N/A
  665.  
  666.  DESCRIPTION: Goto the Column Number given.
  667.  
  668.  See Also   : Goto_Line Goto_Buffer
  669.  
  670. Next_Buffer
  671.  
  672. COMMAND     : Next_Buffer
  673.  
  674.  PARAMETERS : NONE
  675.  
  676.  DESCRIPTION: Switch to the next buffer in the list.
  677.  
  678.  See Also   : Prev_Buffer Goto_Buffer Kill_Buffer Make_Buffer Print_Buffer
  679.  
  680. Prev_Buffer
  681.  
  682. COMMAND     : Prev_Buffer
  683.  
  684.  PARAMETERS : NONE
  685.  
  686.  DESCRIPTION: Switch to the previous buffer in the list.
  687.  
  688.  See Also   : Next_Buffer Goto_Buffer Kill_Buffer Make_Buffer Print_Buffer
  689.  
  690. Goto_Buffer
  691.  
  692. COMMAND     : Goto_Buffer
  693.  
  694.  PARAMETERS : NAME
  695.  
  696.  DESCRIPTION: Switch to the buffer given.  If NO buffer given then show a
  697.               requester listing all buffers and select a buffer to switch to.
  698.  
  699.  See Also   : Next_Buffer Prev_Buffer Kill_Buffer Make_Buffer Print_Buffer
  700.  
  701. Next_Fold
  702.  
  703. COMMAND     : Next_Fold
  704.  
  705.  PARAMETERS : NONE
  706.  
  707.  DESCRIPTION: Move to the Next Fold if any.
  708.  
  709.  See Also   : Fold_Line Unfold Prev_Fold Fold_Block Unfold_Line
  710.  
  711. Prev_Fold
  712.  
  713. COMMAND     : Prev_Fold
  714.  
  715.  PARAMETERS : NONE
  716.  
  717.  DESCRIPTION: Move to the Previous Fold if any.
  718.  
  719.  See Also   : Fold_Line Unfold Next_Fold Fold_Block Unfold_Line
  720.  
  721. Next_Mark
  722.  
  723. COMMAND     : Next_Mark
  724.  
  725.  PARAMETERS : NONE
  726.  
  727.  DESCRIPTION: Make the Next Mark the Current Mark.
  728.  
  729.  See Also   : Mark Unmark Prev_Mark Goto_Mark
  730.  
  731. Prev_Mark
  732.  
  733. COMMAND     : Prev_Mark
  734.  
  735.  PARAMETERS : NONE
  736.  
  737.  DESCRIPTION: Make the previous Mark the Current Mark.
  738.  
  739.  See Also   : Mark Unmark Next_Mark Goto_Mark
  740.  
  741. Goto_Mark
  742.  
  743. COMMAND     : Goto_Mark
  744.  
  745.  PARAMETERS : MARKNUM/N
  746.  
  747.  DESCRIPTION: If no parameter then 
  748.                  move to the current Mark
  749.               else
  750.                  move to mark number NUM.
  751.  
  752.  See Also   : Mark Unmark Next_Mark Prev_Mark
  753.  
  754. Match
  755.  
  756. COMMAND     : Match
  757.  
  758.  PARAMETERS : NONE
  759.  
  760.  DESCRIPTION: Currently matches up {([ & ])}
  761.  
  762.  See Also   : Count_Braces
  763.  
  764. Return
  765.  
  766. COMMAND     : Return
  767.  
  768.  PARAMETERS : NONE
  769.  
  770.  DESCRIPTION: Splits the line at the Cursor position.
  771.  
  772. Backspace
  773.  
  774. COMMAND     : Backspace
  775.  
  776.  PARAMETERS : NONE
  777.  
  778.  DESCRIPTION: Deletes the character to the left of the Cursor.  If the
  779.               Cursor is at the start of the line then Join the current line
  780.               to the line above.
  781.  
  782.  See Also   : Del
  783.  
  784. Del
  785.  
  786. COMMAND     : Del
  787.  
  788.  PARAMETERS : NONE
  789.  
  790.  DESCRIPTION: Deletes the character under the Cursor.  If the Cursor is at
  791.               the end of the line the join the line below to the current
  792.               line.
  793.  
  794.  See Also   : Backspace
  795.  
  796. Del_Line
  797.  
  798. COMMAND     : Del_Line
  799.  
  800.  PARAMETERS : NONE
  801.  
  802.  DESCRIPTION: Delete the current line.
  803.  
  804.  See Also   : Del_EOL Del_SOL Block_Delete Undo
  805.  
  806. Word_Delete
  807.  
  808. COMMAND     : Word_Delete
  809.  
  810.  PARAMETERS : NONE
  811.  
  812.  DESCRIPTION: Delete the Word beneath the Cursor.
  813.  
  814.  See Also   : Word_Left Word_Right Word_End Complete_Word
  815.  
  816. Del_EOL
  817.  
  818. COMMAND     : Del_EOL
  819.  
  820.  PARAMETERS : NONE
  821.  
  822.  DESCRIPTION: Delete all characters from Cursor until the End Of Line.
  823.  
  824.  See Also   : Del_Line Del_SOL Block_Delete Undo
  825.  
  826. Del_SOL
  827.  
  828. COMMAND     : Del_SOL
  829.  
  830.  PARAMETERS : NONE
  831.  
  832.  DESCRIPTION: Delete all characters from Cursor until the Start Of Line.
  833.  
  834.  See Also   : Del_EOL Del_Line Block_Delete Undo
  835.  
  836. Block_Begin
  837.  
  838. COMMAND     : Block_Begin
  839.  
  840.  PARAMETERS : NONE
  841.  
  842.  DESCRIPTION: Set the Start of a block to the Cursor position.
  843.  
  844.  See Also   : Block_End Block_Copy Block_Delete Block_Move
  845.               Block_Hide Block_Mode Block_Clip Clip_Block Block_File
  846.               File_Block Undo Indent_Block Unindent_Block
  847.  
  848.  
  849. Block_End
  850.  
  851. COMMAND     : Block_End
  852.  
  853.  PARAMETERS : NONE
  854.  
  855.  DESCRIPTION: Set the End of a block to the Cursor position.
  856.  
  857.  See Also   : Block_Begin Block_Copy Block_Delete Block_Move
  858.               Block_Hide Block_Mode Block_Clip Clip_Block Block_File
  859.               File_Block Undo Indent_Block Unindent_Block
  860.  
  861. Block_Copy
  862.  
  863. COMMAND     : Block_Copy
  864.  
  865.  PARAMETERS : NONE
  866.  
  867.  DESCRIPTION: Copy a Block to the Cursor position.
  868.  
  869.  See Also   : Block_Begin Block_End Block_Delete Block_Move
  870.               Block_Hide Block_Mode Block_Clip Clip_Block Block_File
  871.               File_Block Undo Indent_Block Unindent_Block
  872.  
  873. Block_Delete
  874.  
  875. COMMAND     : Block_Delete
  876.  
  877.  PARAMETERS : NONE
  878.  
  879.  DESCRIPTION: Delete the current Block.
  880.  
  881.  See Also   : Block_Begin Block_End Block_Copy Block_Move
  882.               Block_Hide Block_Mode Block_Clip Clip_Block Block_File
  883.               File_Block Undo Indent_Block Unindent_Block
  884.  
  885. Block_Move
  886.  
  887. COMMAND     : Block_Move
  888.  
  889.  PARAMETERS : NONE
  890.  
  891.  DESCRIPTION: Move the current block to the Cursor position.
  892.  
  893.  See Also   : Block_Begin Block_End Block_Copy Block_Delete
  894.               Block_Hide Block_Mode Block_Clip Clip_Block Block_File
  895.               File_Block Undo Indent_Block Unindent_Block
  896.  
  897. Block_Hide
  898.  
  899. COMMAND     : Block_Hide
  900.  
  901.  PARAMETERS : NONE
  902.  
  903.  DESCRIPTION: Turn off the block.
  904.  
  905.  See Also   : Block_Begin Block_End Block_Copy Block_Delete Block_Move
  906.               Block_Mode Block_Clip Clip_Block Block_File
  907.               File_Block Undo Indent_Block Unindent_Block
  908.  
  909. Block_Clip
  910.  
  911. COMMAND     : Block_Clip
  912.  
  913.  PARAMETERS : NONE
  914.  
  915.  DESCRIPTION: Copy the Current block to the clipboard Unit 0
  916.  
  917.  See Also   : Block_Begin Block_End Block_Copy Block_Delete Block_Move
  918.               Block_Hide Block_Mode Clip_Block Block_File
  919.               File_Block Undo Indent_Block Unindent_Block
  920.  
  921. Clip_Block
  922.  
  923. COMMAND     : Clip_Block
  924.  
  925.  PARAMETERS : NONE
  926.  
  927.  DESCRIPTION: Copy the contents of Clipboard Unit 0 to the Buffer and make
  928.               it the current block.
  929.  
  930.  See Also   : Block_Begin Block_End Block_Copy Block_Delete Block_Move
  931.               Block_Hide Block_Mode Block_Clip Block_File
  932.               File_Block Undo Indent_Block Unindent_Block
  933.  
  934. Block_File
  935.  
  936. COMMAND     : Block_File
  937.  
  938.  PARAMETERS : NONE
  939.  
  940.  DESCRIPTION: Copy the current block to a File.
  941.  
  942.  See Also   : Block_Begin Block_End Block_Copy Block_Delete Block_Move
  943.               Block_Hide Block_Mode Block_Clip Clip_Block
  944.               File_Block Undo Indent_Block Unindent_Block
  945.  
  946. File_Block
  947.  
  948. COMMAND     : File_Block
  949.  
  950.  PARAMETERS : NONE
  951.  
  952.  DESCRIPTION: Copy a file into the current buffer and make it the current
  953.               block.
  954.  
  955.  See Also   : Block_Begin Block_End Block_Copy Block_Delete Block_Move
  956.               Block_Hide Block_Mode Block_Clip Clip_Block Block_File
  957.               Undo Indent_Block Unindent_Block
  958.  
  959. Block_Mode
  960.  
  961. COMMAND     : Block_Mode
  962.  
  963.  PARAMETERS : NONE
  964.  
  965.  DESCRIPTION: Switch between Normal Block Mode and Column Block Mode.
  966.  
  967.  See Also   : Block_Begin Block_End Block_Copy Block_Delete Block_Move
  968.               Block_Hide Block_Clip Clip_Block Block_File
  969.               File_Block Undo Indent_Block Unindent_Block
  970.  
  971. Indent_Block
  972.  
  973. COMMAND     : Indent_Block
  974.  
  975.  PARAMETERS : NONE
  976.  
  977.  DESCRIPTION: Inserts 1 space before each fully highlighted line.
  978.  
  979.  See Also   : Block_Begin Block_End Block_Copy Block_Delete Block_Move
  980.               Block_Hide Block_Mode Block_Clip Clip_Block Block_File
  981.               File_Block Undo Unindent_Block
  982.  
  983. Unindent_Block
  984.  
  985. COMMAND     : Unindent_Block
  986.  
  987.  PARAMETERS : NONE
  988.  
  989.  DESCRIPTION: Removes 1 space before each fully highlighted line.
  990.  
  991.  See Also   : Block_Begin Block_End Block_Copy Block_Delete Block_Move
  992.               Block_Hide Block_Mode Block_Clip Clip_Block Block_File
  993.               File_Block Undo Indent_Block
  994.  
  995. Undo
  996.  
  997. COMMAND     : Undo
  998.  
  999.  PARAMETERS : NONE
  1000.  
  1001.  DESCRIPTION: Reverses the effects of Block_Delete, Del_Line & Word_Delete.
  1002.               The Undo limit is set by MAXUNDO.
  1003.  
  1004.  See Also   : Block_Begin Block_End Block_Copy Block_Delete Block_Move
  1005.               Block_Hide Block_Mode Block_Clip Clip_Block Block_File
  1006.               File_Block Indent_Block Unindent_Block
  1007.  
  1008. Split_Window
  1009.  
  1010. COMMAND     : Split_Window
  1011.  
  1012.  PARAMETERS : NONE
  1013.  
  1014.  DESCRIPTION: Split the current window into 2 windows.
  1015.  
  1016.  See Also   : Close_Window Zoom Explode Refresh
  1017.  
  1018. Close_Window
  1019.  
  1020. COMMAND     : Close_Window
  1021.  
  1022.  PARAMETERS : NONE
  1023.  
  1024.  DESCRIPTION: Close the current window.
  1025.  
  1026.  See Also   : Split_Window Zoom Explode Refresh
  1027.  
  1028. Zoom
  1029.  
  1030. COMMAND     : Zoom
  1031.  
  1032.  PARAMETERS : NONE
  1033.  
  1034.  DESCRIPTION: Switch between Full sized window and current size of window.
  1035.  
  1036.  See Also   : Split_Window Close_Window Explode Refresh
  1037.  
  1038. Explode
  1039.  
  1040. COMMAND     : Explode
  1041.  
  1042.  PARAMETERS : NONE
  1043.  
  1044.  DESCRIPTION: Make the current window full size.
  1045.  
  1046.  See Also   : Split_Window Close_Window Zoom Refresh
  1047.  
  1048. Refresh
  1049.  
  1050. COMMAND     : Refresh
  1051.  
  1052.  PARAMETERS : NONE
  1053.  
  1054.  DESCRIPTION: Force a refresh of all windows.
  1055.  
  1056.  See Also   : Split_Window Close_Window Zoom Explode
  1057.  
  1058. Load_File
  1059.  
  1060. COMMAND     : Load_File
  1061.  
  1062.  PARAMETERS : NAME,OVER/S,NODUP/S
  1063.  
  1064.  DESCRIPTION: Load a file into a Buffer.
  1065.  
  1066.               NAME  : The name of the file to load - Full path preferred.
  1067.                       If not present then get a filename from the filerequester.
  1068.               OVER  : If present the current buffer will be OVERWRITTEN.
  1069.               NODUP : If present the Buffer list will be searched and if the file
  1070.                       requested is already in memory then the file will not be
  1071.                       loaded.
  1072.  
  1073.  See Also   : Save_File Print_File Reload
  1074.  
  1075. Save_File
  1076.  
  1077. COMMAND     : Save_File
  1078.  
  1079.  PARAMETERS : NEW/S
  1080.  
  1081.  DESCRIPTION: Save the current buffer.  If the file is a temp file or parameter NEW
  1082.               present then request a new filename.
  1083.  
  1084.  See Also   : Load_File Print_File Reload
  1085.  
  1086. Print_File
  1087.  
  1088. COMMAND     : Print_File
  1089.  
  1090.  PARAMETERS : NAME
  1091.  
  1092.  DESCRIPTION: Print the given file.  If no file given then prompt for a filename.
  1093.               Printing is accomplished by executing the PRINTER string with the
  1094.               filename appended.
  1095.  
  1096.  See Also   : Load_File Save_File Reload
  1097.  
  1098. Reload
  1099.  
  1100. COMMAND     : Reload
  1101.  
  1102.  PARAMETERS : NONE
  1103.  
  1104.  DESCRIPTION: Read the Reload file (Skoed.Memory) and load all files
  1105.               contained in it.
  1106.  
  1107.  See Also   : Load_File Save_File Print_File
  1108.  
  1109. Kill_Buffer
  1110.  
  1111. COMMAND     : Kill_Buffer
  1112.  
  1113.  PARAMETERS : NONE
  1114.  
  1115.  DESCRIPTION: Free the current Buffer.
  1116.  
  1117.  See Also   : Next_Buffer Prev_Buffer Goto_Buffer Make_Buffer Print_Buffer
  1118.  
  1119. Make_Buffer
  1120.  
  1121. COMMAND     : Make_Buffer
  1122.  
  1123.  PARAMETERS : NONE
  1124.  
  1125.  DESCRIPTION: Create a new buffer named "Temp". Please note temp files are
  1126.               not saved and are not put into memory files.
  1127.  
  1128.  See Also   : Next_Buffer Prev_Buffer Goto_Buffer Kill_Buffer Print_Buffer
  1129.  
  1130. Print_Buffer
  1131.  
  1132. COMMAND     : Print_Buffer
  1133.  
  1134.  PARAMETERS : NAME
  1135.  
  1136.  DESCRIPTION: Print the buffer specified. If no buffer specified then select a
  1137.               buffer from the list.  Printing is accomplished by saveing the buffer
  1138.               to C_DIR and then append the filename to the PRINTER string before
  1139.               executeing the PRINTER string.
  1140.  
  1141.  See Also   : Next_Buffer Prev_Buffer Goto_Buffer Kill_Buffer Make_Buffer
  1142.  
  1143. Compile
  1144.  
  1145. COMMAND     : Compile
  1146.  
  1147.  PARAMETERS : NONE
  1148.  
  1149.  DESCRIPTION: Save the current file to C_DIR, Append the filename to the
  1150.               compile string and then Execute it.
  1151.  
  1152.  See Also   : Link Make Run Errors New_CLI
  1153.  
  1154. Link
  1155.  
  1156. COMMAND     : Link
  1157.  
  1158.  PARAMETERS : NONE
  1159.  
  1160.  DESCRIPTION: Execute the LINK string.
  1161.  
  1162.  See Also   : Compile Make Run Errors New_CLI
  1163.  
  1164. Run
  1165.  
  1166. COMMAND     : Run
  1167.  
  1168.  PARAMETERS : NONE
  1169.  
  1170.  DESCRIPTION: Display a requester asking for a EXECUTE string and then
  1171.               execute it.
  1172.  
  1173.  See Also   : Compile Make Link Errors New_CLI
  1174.  
  1175. Make
  1176.  
  1177. COMMAND     : Make
  1178.  
  1179.  PARAMETERS : NONE
  1180.  
  1181.  DESCRIPTION: Execute the MAKE string.
  1182.  
  1183.  See Also   : Compile Link Run Errors New_CLI
  1184.  
  1185. Errors
  1186.  
  1187. COMMAND     : Errors
  1188.  
  1189.  PARAMETERS : NONE
  1190.  
  1191.  DESCRIPTION: Execute the ERRORS string.
  1192.  
  1193.  See Also   : Compile Make Run Link New_CLI
  1194.  
  1195. New_CLI
  1196.  
  1197. COMMAND     : New_CLI
  1198.  
  1199.  PARAMETERS : NONE
  1200.  
  1201.  DESCRIPTION: Execute the NEWCLI string.
  1202.  
  1203.  See Also   : Compile Make Run Errors Link
  1204.  
  1205. Find
  1206.  
  1207. COMMAND     : Find
  1208.  
  1209.  PARAMETERS : NONE
  1210.  
  1211.  DESCRIPTION: Find a String.
  1212.               The following options are available :
  1213.                   No Care Case : Case is ignored in search.
  1214.                   All Buffers  : Search all buffers for word.
  1215.                   Continuous   : Count words instead of search.
  1216.                                  (Not yet implemented)
  1217.  
  1218.  See Also   : Replace Again
  1219.  
  1220. Replace
  1221.  
  1222. COMMAND     : Replace
  1223.  
  1224.  PARAMETERS : NONE
  1225.  
  1226.  DESCRIPTION: Find and Replace a string.
  1227.               The following options are available :
  1228.                   No Care Case : Case is ignored in search.
  1229.                   All Buffers  : Search all buffers for word.
  1230.                   Continuous   : Replace all words.
  1231.                   Hold Updates : Keep updates to minimum (Fast)
  1232.                   Query        : Ask before replacing.
  1233.  
  1234.  See Also   : Find Again
  1235.  
  1236. Again
  1237.  
  1238. COMMAND     : Again
  1239.  
  1240.  PARAMETERS : NONE
  1241.  
  1242.  DESCRIPTION: Repeat previous Find or Replace command
  1243.  
  1244.  See Also   : Find Replace
  1245.  
  1246. Mark
  1247.  
  1248. COMMAND     : Mark
  1249.  
  1250.  PARAMETERS : MARKNUM/N
  1251.  
  1252.  DESCRIPTION: Create a new mark at current position.
  1253.               An optional Number may be given as a parameter and will be assigned to
  1254.               this mark.  Parameter must be > 0.
  1255.  
  1256.  See Also   : Unmark Next_Mark Prev_Mark Goto_Mark
  1257.  
  1258. Unmark
  1259.  
  1260. COMMAND     : Unmark
  1261.  
  1262.  PARAMETERS : NONE
  1263.  
  1264.  DESCRIPTION: Remove the current Mark.
  1265.  
  1266.  See Also   : Mark Next_Mark Prev_Mark Goto_Mark
  1267.  
  1268. Fold_Line
  1269.  
  1270. COMMAND     : Fold_Line
  1271.  
  1272.  PARAMETERS : NONE
  1273.  
  1274.  DESCRIPTION: Fold the current line.
  1275.  
  1276.  See Also   : Unfold Next_Fold Prev_Fold Fold_Block Unfold_Line
  1277.  
  1278. Unfold_Line
  1279.  
  1280. COMMAND     : Unfold_Line
  1281.  
  1282.  PARAMETERS : NONE
  1283.  
  1284.  DESCRIPTION: Unfold a line from a fold
  1285.  
  1286.  See Also   : Unfold Next_Fold Prev_Fold Fold_Block Fold_Line
  1287.  
  1288. Fold_Block
  1289.  
  1290. COMMAND     : Fold_Block
  1291.  
  1292.  PARAMETERS : NONE
  1293.  
  1294.  DESCRIPTION: Fold an entire block
  1295.  
  1296.  See Also   : Unfold Next_Fold Prev_Fold Fold_Line Unfold_Line
  1297.  
  1298. Unfold
  1299.  
  1300. COMMAND     : Unfold
  1301.  
  1302.  PARAMETERS : NONE
  1303.  
  1304.  DESCRIPTION: Unfold the entire fold
  1305.  
  1306.  See Also   : Next_Fold Prev_Fold Fold_Block Unfold_Line Fold_Line
  1307.  
  1308. Str_Size
  1309.  
  1310. COMMAND     : Str_Size
  1311.  
  1312.  PARAMETERS : NONE
  1313.  
  1314.  DESCRIPTION: Display the length of a string that the Cursor is in.
  1315.                   - A number preceded by \ (eg \123) is considered 1 char.
  1316.                   - A \ followed by a character is considered 1 char.
  1317.  
  1318. None
  1319.  
  1320. COMMAND     : None
  1321.  
  1322.  PARAMETERS : NONE
  1323.  
  1324.  DESCRIPTION: Do Nothing. :-) Well actually this will force a refresh of the menu
  1325.               strip.
  1326.  
  1327.  
  1328. Set_Var
  1329.  
  1330. COMMAND     : Set_Var
  1331.  
  1332.  PARAMETERS : VAR/A,VALUE,TOGGLE/S
  1333.  
  1334.  DESCRIPTION: Set an internal variable.
  1335.  
  1336.                 VAR is the variable name and must be one of :
  1337.                   C_DIR
  1338.                   COMPILE
  1339.                   LINK
  1340.                   MAKE
  1341.                   EXECUTE
  1342.                   ERRORS
  1343.                   CLI
  1344.                   INSERT
  1345.                   INDENT
  1346.                   CAPTIVECRSR
  1347.                   MEMORY
  1348.                   BACKUPS
  1349.                   TABSIZE
  1350.                   AUTOTIME
  1351.                   MAXUNDO
  1352.                   RELOAD
  1353.                   PRINTER
  1354.                   SAVETABS
  1355.                   LOADTABS
  1356.                   TABSSPACES
  1357.                   SCRIPT
  1358.  
  1359.                 VALUE is the value to set the variable to and may be :
  1360.                         a BOOLEAN -> TRUE/FALSE
  1361.                         a string  -> "fred"
  1362.                         a number  -> 123
  1363.  
  1364.                 TOGGLE if present will toggle the value of a boolean variable
  1365.  
  1366.  See Also   : Get_Var
  1367.  
  1368. Get_Var
  1369.  
  1370. COMMAND     : Get_Var
  1371.  
  1372.  PARAMETERS : VAR/A
  1373.  
  1374.  DESCRIPTION: This command is for ARexx only and will retrieve the variable
  1375.               specified.
  1376.                 VAR is the variable whose value you wish to retrieve and must be
  1377.                 one of :
  1378.                          C_DIR
  1379.                          COMPILE
  1380.                          LINK
  1381.                          MAKE
  1382.                          EXECUTE
  1383.                          ERRORS
  1384.                          CLI
  1385.                          INSERT
  1386.                          INDENT
  1387.                          CAPTIVECRSR
  1388.                          MEMORY
  1389.                          BACKUPS
  1390.                          TABSIZE
  1391.                          AUTOTIME
  1392.                          MAXUNDO
  1393.                          RELOAD
  1394.                          PRINTER
  1395.                          SAVETABS
  1396.                          LOADTABS
  1397.                          TABSSPACES
  1398.                          SCRIPT
  1399.                          CurrX
  1400.                          CurrY
  1401.                          LineNum
  1402.                          MaxLines
  1403.                          FileName
  1404.                          FilePath
  1405.                          CurrLine
  1406.                          CurrWord
  1407.  
  1408.  See Also   : Set_Var
  1409.  
  1410. Variables
  1411.  
  1412.         Descriptions of variables are :
  1413.  
  1414. C_DIR  <String>
  1415.   This string stores the directory to save the current buffer to when the
  1416. compile command is used.  Set this to "" if you want to save to the current
  1417. directory.
  1418.  
  1419. COMPILE <String>
  1420.   This is the string that will be executed by the compile command. the 
  1421. C_DIR and the filename of the current buffer will be appended to this
  1422. string.
  1423.  
  1424. LINK <String>
  1425.   This is the string that will be executed by the link command.
  1426.  
  1427. MAKE <String>
  1428.   This is the string that will be executed by the Make command.
  1429.  
  1430. EXECUTE <String>
  1431.   This is the string that will be the default for the execute command.
  1432.   
  1433. ERRORS <String>
  1434.   This is the string that will be executed by the Error command.
  1435.  
  1436. CLI <String>
  1437.   This is the string that will be executed by the CLI command.
  1438.  
  1439. INSERT <Boolean>
  1440.   This variable is set to TRUE for insert mode and FALSE for Overwrite mode.
  1441.  
  1442. INDENT <Boolean>
  1443.   This variable is set to TRUE for Indent On and FALSE for No Indent.
  1444.  
  1445. CAPTIVECRSR <Boolean>
  1446.   This variable is set to TRUE for a Captive Cursor and FALSE for a free
  1447. Cursor.
  1448.  
  1449. MEMORY <Boolean>
  1450.   This variable is set to TRUE if SkoEd is to save all files loaded to a
  1451. Memory file on exit.
  1452.  
  1453. BACKUPS <Boolean>
  1454.   This variable is set to TRUE is SkoEd is to rename the file being saved to
  1455. <File>.bak before saving.
  1456.  
  1457. TABSIZE <Integer>
  1458.   This variable is set to the number of spaces that a tab is defined as.
  1459.  
  1460. AUTOTIME <Integer>
  1461.   This variable is the number of minutes before the AutoSave command is
  1462. invoked.  Setting this value to 0 will turn off AutoSave.
  1463.  
  1464. MAXUNDO <Integer>
  1465.   This variable defines the maximum number of Undo commands that can be
  1466. performed.
  1467.  
  1468. RELOAD <Boolean>
  1469.   This variable is set to TRUE if you want skoed to automatically invoke the
  1470. reload command upon startup.
  1471.  
  1472. PRINTER <String>
  1473.   This is the string that will be executed by the print commands.  A 
  1474. filename will be appended to this string.
  1475.  
  1476. SAVETABS <Boolean>
  1477.   This variable is set to TRUE if you want leading spaces on a line to be 
  1478. converted to TABS when saving the file.
  1479.  
  1480. LOADTABS <Boolean>
  1481.   This variable is set to TRUE wif you want TABS to be converted to SPACES
  1482. on loading a file.  FALSE will leave TABS alone.
  1483.  
  1484. TABSSPACES <Boolean>
  1485.   This variable is set to FALSE if you want to insert a TAB character into
  1486. your file.  TRUE will convert the TAB to upto TABSIZE spaces.
  1487.  
  1488. SCRIPT <Boolean>
  1489.   This variable is set to TRUE if the current file has the Script protection
  1490. bit set.  FALSE otherwise
  1491.  
  1492. CurrX <Integer> <Read Only>
  1493.   This is the column position of the cursor. Ranges from 1 to 4096.
  1494.  
  1495. CurrY <Integer> <Read Only>
  1496.   This is the abs position of the cursor relative to the Top most visible
  1497. line in the window.  Ranges from 1 to WindowSize.
  1498.  
  1499. LineNum <Integer> <Read Only>
  1500.   This is the current line number of the cursor.
  1501.  
  1502. MaxLines <Integer> <Read Only>
  1503.   This is the number of lines in the file.
  1504.  
  1505. FileName <String>
  1506.   This is the filename of the file.
  1507.  
  1508. FilePath <String>
  1509.   This is the filepath of the file.
  1510.  
  1511. CurrLine <String> <Read Only>
  1512.   This is the current line.
  1513.  
  1514. CurrWord <String> <Read Only>
  1515.   This is the word beneath the Cursor.
  1516.  
  1517.  
  1518. Buffer_Info
  1519.  
  1520. COMMAND     : Buffer_Info
  1521.  
  1522.  PARAMETERS : NONE
  1523.  
  1524.  DESCRIPTION: Give some hopefully usefull information about the current buffer.
  1525.               Also allows you to :
  1526.                  convert the file from AMIGA -> IBM and back.
  1527.                  Set/Unset the Script bit.
  1528.                  Set/Unset the Read Only flag.
  1529.  
  1530. Set_Env
  1531.  
  1532. COMMAND     : Set_Env
  1533.  
  1534.  PARAMETERS : NONE
  1535.  
  1536.  DESCRIPTION: Allow you to set a keymapping on the fly.
  1537.               basically requests a string and parses it in the same manner as the
  1538.               Skoed.Config file is.
  1539.  
  1540. Set_Vars
  1541.  
  1542. COMMAND     : Set_Vars
  1543.  
  1544.  PARAMETERS : NONE
  1545.  
  1546.  DESCRIPTION: Allow you to set various variables via a requester.
  1547.  
  1548. Count_Braces
  1549.  
  1550. COMMAND     : Count_Braces
  1551.  
  1552.  PARAMETERS : NONE
  1553.  
  1554.  DESCRIPTION: Count all the { and } characters in the current buffer.
  1555.  
  1556.  
  1557.  See Also   : Match
  1558.  
  1559. Complete_Word
  1560.  
  1561. COMMAND     : Complete_Word
  1562.  
  1563.  PARAMETERS : NONE
  1564.  
  1565.  DESCRIPTION: Attempt to complete the word that was started.
  1566.               This will only work if the word has been used previously in the file.
  1567.  
  1568.  See Also   : Word_Left Word_Right Word_End Word_Delete
  1569.  
  1570. Auto_Save
  1571.  
  1572. COMMAND     : Auto_Save
  1573.  
  1574.  PARAMETERS : NONE
  1575.  
  1576.  DESCRIPTION: Save the file that has had the most changes as <File>.Auto
  1577.  
  1578. Tab
  1579.  
  1580. COMMAND     : Tab
  1581.  
  1582.  PARAMETERS : NONE
  1583.  
  1584.  DESCRIPTION: Insert/Overwrite with TABSIZE spaces.
  1585.  
  1586. Exit
  1587.  
  1588. COMMAND     : Exit
  1589.  
  1590.  PARAMETERS : NONE
  1591.  
  1592.  DESCRIPTION: Exit SkoEd.
  1593.  
  1594. Iconify
  1595.  
  1596. COMMAND     : Iconify
  1597.  
  1598.  PARAMETERS : NONE
  1599.  
  1600.  DESCRIPTION: Closes the SkoEd screen and window and open up a small window
  1601.               on WorkBench.  Use Right mouse button to UnIconify.
  1602.  
  1603. Reconfigure
  1604.  
  1605. COMMAND     : Reconfigure
  1606.  
  1607.  PARAMETERS : NONE
  1608.  
  1609.  DESCRIPTION: This removes all configuration details and reloads them from the
  1610.               SkoEd.Config ans SkoEd.Macro files.
  1611.  
  1612. Msg
  1613.  
  1614. COMMAND     : Msg
  1615.  
  1616.  PARAMETERS : MESSAGE/A/K
  1617.  
  1618.  DESCRIPTION: Puts the message given onto the message line.
  1619.  
  1620. ARexxCommand
  1621.  
  1622. COMMAND     : ARexx
  1623.  
  1624.  PARAMETERS : COMMAND/A
  1625.  
  1626.  DESCRIPTION: Execute an ARexx script given in COMMAND.
  1627.               Note: the script is executed Asynchronously.  SkoEd will continue to
  1628.               accept input from the user even if ARexx is giving commands.  However
  1629.               I believe under the current implementation if ARexx begins
  1630.               communicating with SkoEd then User commands are held until ARexx has
  1631.               finished but don't bet on it.
  1632.  
  1633. EXAMPLES
  1634.  
  1635.  
  1636.  
  1637.         Some Examples of configuring keys.
  1638.  
  1639. ^Y = Del_Line; This will delete the current line.
  1640. CTRL Y=Del_Line;
  1641.     ^ Note the space
  1642.  
  1643. ^Q = Exit; Exit Skoed
  1644. $F1 = "Hello"; Output the string "Hello" when Function key 1 is pressed.
  1645. &RETURN = Return; Make the enter key on the numeric keypad the same as Return key.
  1646. ^UP = Page_Up;
  1647. $F5 = Zoom;
  1648. ^$F5 = Explode;
  1649. ^KB = Block_Begin;
  1650. !LP = Prev_Buffer;
  1651.  
  1652. Note that ^> is incorrect as the shift key needs to be down to get >.  You
  1653. should use ^#> or #^> or SHIFT CTRL >.
  1654.  
  1655. SkoEd sets the following keys automatically :
  1656.  
  1657.   RETURN = Return;
  1658.   &RETURN = Return;
  1659.   UP = Up;
  1660.   DOWN = Down;
  1661.   LEFT = Left;
  1662.   RIGHT = Right;
  1663.   DEL = Del;
  1664.   BACKSPACE = Backspace;
  1665.   TAB = Tab;
  1666.  
  1667.         Some examples of setting variables in Config files.
  1668.  
  1669. COMPILE = "cc";
  1670. CLI = "AShell";
  1671. MEMORY = FALSE;
  1672. BACKUPS = TRUE;
  1673. TABSIZE = 4;
  1674. MAXUNDO = 10;
  1675.  
  1676.         Have a look at the config and macro files given with this
  1677. distribution for more examples.  A lot of it is test configs that I use
  1678. so there is a fair range of key and variable configurations.
  1679.  
  1680.  
  1681. DISCLAIMER
  1682.  
  1683.  
  1684.  
  1685. THIS PROGRAM IS PROVIDED ON AN "AS IS" BASIS, NO WARRANTIES ARE MADE, EITHER
  1686. EXPRESSED OR IMPLIED. IN NO EVENT WILL I, DAVID MCPAUL, BE LIABLE FOR ANY
  1687. DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING FROM ANY USE
  1688. OR MISUSE OF THIS PROGRAM. THE ENTIRE RISK AS TO THE RESULTS AND PERFORMANCE
  1689. OF THIS PROGRAM IS ASSUMED BY YOU.
  1690.  
  1691. IBM is a registered trademark of International Business Machines Corp.
  1692. AMIGA is a registered trademark of Commodore-Amiga, Inc.
  1693. ReqTools is Copyright (c) Nico François
  1694.